Skip to main content

API Reference

API Specifications​

ECR REST API 2.x
ECR REST API WAN 2.x
ECR REST API 1.x
Portal API 1.0

Supported Versions​

1.x​

Uses HTTPS with a self-signed TLS certificate. For local devices, hostname verification might need to be disabled or overridden. Certificate files include ECR-REST.crt and ECR-REST.pem.

2.x​

Uses HTTP with a hash-based authentication mechanism. Requests include an integration key and a computed hash generated using a secret key. The secret key must never be transmitted in requests.

Compatibility Notes​

Version 1.x uses HTTPS with a self-signed TLS certificate and might require hostname verification to be disabled for local integrations.

Version 2.x uses HTTP and the Samport-Keyed-Hash-v1 authorization scheme with an integration key and secret key.

Version 2.x responses include a Server-Authorization header for response integrity verification.

The secret key must be used only to generate hashes and must never be sent to the terminal.

Migration Guidance​

Version 1.x and 2.x use different authentication mechanisms. When migrating to version 2.x:

  • Use the Samport-Keyed-Hash-v1 authorization scheme.
  • Include the required timestamp and computed hash in the Authorization header.
  • Obtain and configure both an integration key and a secret key.
  • Replace TLS certificate-based authentication with hash-based request authentication.
  • Validate the Server-Authorization header when response verification is required.

Endpoints​

Endpoints are categorised by their primary function. Each endpoint page follows a consistent structure to assist with integration.

To be continued……………